Skip to content

Add custom launch file and timing issues info to Docs#549

Open
zacharyyamaoka wants to merge 3 commits intoros-controls:rollingfrom
zacharyyamaoka:rolling
Open

Add custom launch file and timing issues info to Docs#549
zacharyyamaoka wants to merge 3 commits intoros-controls:rollingfrom
zacharyyamaoka:rolling

Conversation

@zacharyyamaoka
Copy link
Copy Markdown

@zacharyyamaoka zacharyyamaoka commented Apr 13, 2025

Add some new notes to docs, that I wish were there when I first read them!

Related to: #533

@zacharyyamaoka
Copy link
Copy Markdown
Author

btw sorry I think I should have made another branch...

Comment thread doc/index.rst
Comment thread doc/index.rst Outdated
Comment thread doc/index.rst Outdated
Comment thread doc/index.rst Outdated
Comment thread doc/index.rst Outdated
Comment thread doc/index.rst Outdated
zacharyyamaoka and others added 2 commits April 15, 2025 16:06
switch single ticks to double ticks

Co-authored-by: Alejandro Hernández Cordero <[email protected]>
@zacharyyamaoka
Copy link
Copy Markdown
Author

Ok, made thoose formating changes now!

Copy link
Copy Markdown
Collaborator

@ahcorde ahcorde left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Copy Markdown
Member

@christophfroehlich christophfroehlich left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your effort, see my comments in the code

Comment thread doc/index.rst
Comment on lines +408 to +410
To get started with your own launch file using `gz_ros2_control`, refer to the example launch files in the repository:

`Example launch files <https://github.com/ros-controls/gz_ros2_control/tree/rolling/gz_ros2_control_demos/launch>`_
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
To get started with your own launch file using `gz_ros2_control`, refer to the example launch files in the repository:
`Example launch files <https://github.com/ros-controls/gz_ros2_control/tree/rolling/gz_ros2_control_demos/launch>`_
To get started with your own launch file using `gz_ros2_control`, refer to the `example launch files <https://github.com/ros-controls/gz_ros2_control/tree/rolling/gz_ros2_control_demos/launch>`__ in the repository.

Comment thread doc/index.rst
.. code-block:: python

gz_sim = IncludeLaunchDescription(
PythonLaunchDescriptionSource(gz_sim_launch),
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

will need something like

Suggested change
PythonLaunchDescriptionSource(gz_sim_launch),
PythonLaunchDescriptionSource(
[PathJoinSubstitution([FindPackageShare('ros_gz_sim'),
'launch',
'gz_sim.launch.py'])]),

Comment thread doc/index.rst
Explanation of flags:

- ``-r``: Starts the simulator immediately.
- ``-v4``: Sets the logging verbosity to level 4.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would not advertise -v4, because the console log is spammed from gazebo and no one is looking at important warnings/errors of this plugin.

Comment thread doc/index.rst
- ``-r``: Starts the simulator immediately.
- ``-v4``: Sets the logging verbosity to level 4.

2. **Launching the ros_gz_bridge and publishing the `/clock` topic**
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
2. **Launching the ros_gz_bridge and publishing the `/clock` topic**
2. **Launching the ros_gz_bridge and publishing the ``/clock`` topic**

Comment thread doc/index.rst
Timing Issues
-------------

By default, the ``controller_manager`` launched by ``gz_ros2_control`` has ``use_sim_time=true``. If for any reason this is set to ``false``, it will fall back to the system clock.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

when should this happen? This is hardcoded from the plugin?

@ahcorde
Copy link
Copy Markdown
Collaborator

ahcorde commented May 21, 2025

friendly ping @zacharyyamaoka

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Jul 7, 2025

This PR is stale because it has been open for 45 days with no activity. Please tag a maintainer for help on completing this PR, or close it if you think it has become obsolete.

@github-actions github-actions Bot added the stale label Jul 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants